<!DOCTYPE HTML PUBLIC "-//ORA//DTD CD HTML 3.2//EN">
<HTML>
<HEAD>
<TITLE>[Chapter 29] 29.4 java.text.CollationElementIterator (JDK 1.1)</TITLE>
<META NAME="author" CONTENT="David Flanagan">
<META NAME="date" CONTENT="Thu Jul 31 16:32:57 1997">
<META NAME="form" CONTENT="html">
<META NAME="metadata" CONTENT="dublincore.0.1">
<META NAME="objecttype" CONTENT="book part">
<META NAME="otheragent" CONTENT="gmat dbtohtml">
<META NAME="publisher" CONTENT="O'Reilly &amp; Associates, Inc.">
<META NAME="source" CONTENT="SGML">
<META NAME="subject" CONTENT="Java">
<META NAME="title" CONTENT="Java in a Nutshell">
<META HTTP-EQUIV="Content-Script-Type" CONTENT="text/javascript">
</HEAD>
<body vlink="#551a8b" alink="#ff0000" text="#000000" bgcolor="#FFFFFF" link="#0000ee">

<DIV CLASS=htmlnav>
<H1><a href='index.htm'><IMG SRC="gifs/smbanner.gif"
     ALT="Java in a Nutshell" border=0></a></H1>
<table width=515 border=0 cellpadding=0 cellspacing=0>
<tr>
<td width=172 align=left valign=top><A HREF="ch29_03.htm"><IMG SRC="gifs/txtpreva.gif" ALT="Previous" border=0></A></td>
<td width=171 align=center valign=top><B><FONT FACE="ARIEL,HELVETICA,HELV,SANSERIF" SIZE="-1">Chapter 29<br>The java.text Package</FONT></B></TD>
<td width=172 align=right valign=top><A HREF="ch29_05.htm"><IMG SRC="gifs/txtnexta.gif" ALT="Next" border=0></A></td>
</tr>
</table>

&nbsp;
<hr align=left width=515>
</DIV>
<DIV CLASS=sect1>
<h2 CLASS=sect1><A CLASS="TITLE" NAME="JNUT2-CH-29-SECT-4">29.4 java.text.CollationElementIterator (JDK 1.1)</A></h2>

<DIV CLASS=sect2>
<h3 CLASS=sect2><A CLASS="TITLE" NAME="JNUT2-CH-29-SECT-4.1"></A></h3>
</DIV>

<P CLASS=para>
A <tt CLASS=literal>CollationElementIterator</tt> object is returned by
the <tt CLASS=literal>getCollationElementIterator()</tt> method of the
<tt CLASS=literal>RuleBasedCollator</tt> object.  The purpose of this class
is to allow a program to iterate (with the <tt CLASS=literal>next()</tt>
method) through the characters of a string, returning
ordering values for each of the "collation keys" in the
string.  Note that collation keys are not exactly the same
thing as characters.  In the traditional Spanish collation
order, for example, the two-character sequence "ch" is
treated as a single collation key that comes alphabetically
between the letters "c" and "d."

<P CLASS=para>
The value returned by the <tt CLASS=literal>next()</tt> method is the
collation order of the next collation key in the string.
This numeric value can be directly compared to the value
returned by <tt CLASS=literal>next()</tt> for other
<tt CLASS=literal>CollationElementIterator</tt> objects.  The value
returned by <tt CLASS=literal>next()</tt> can also be decomposed into
primary, secondary, and tertiary ordering values with the
static methods of this class.

<P CLASS=para>
This class is used by <tt CLASS=literal>RuleBasedCollator</tt> to implement
its <tt CLASS=literal>compare()</tt> method, and to create
<tt CLASS=literal>CollationKey</tt> objects.  Few applications ever
need to use it directly.

<DIV CLASS=screen>
<P>
<PRE>
public final class <tt CLASS=literal>CollationElementIterator</tt> extends Object {
    // <tt CLASS=literal>No Constructor</tt>
    // <tt CLASS=literal>Constants</tt>
            public static final int <tt CLASS=literal>NULLORDER</tt>;
    // <tt CLASS=literal>Class Methods</tt>
            public static final int <tt CLASS=literal>primaryOrder</tt>(int <tt CLASS=literal>order</tt>);
            public static final short <tt CLASS=literal>secondaryOrder</tt>(int <tt CLASS=literal>order</tt>);
            public static final short <tt CLASS=literal>tertiaryOrder</tt>(int <tt CLASS=literal>order</tt>);
    // <tt CLASS=literal>Public Instance Methods</tt>
            public int <tt CLASS=literal>next</tt>();
            public void <tt CLASS=literal>reset</tt>();
}
</PRE>
</DIV>

</DIV>

<DIV CLASS=sect2>
<h3 CLASS=sect2><A CLASS="TITLE" NAME="JNUT2-CH-29-SECT-4.2">Returned By:</A></h3>

<P CLASS=para>
RuleBasedCollator.getCollationElementIterator()

</DIV>

</DIV>


<DIV CLASS=htmlnav>

<P>
<HR align=left width=515>
<table width=515 border=0 cellpadding=0 cellspacing=0>
<tr>
<td width=172 align=left valign=top><A HREF="ch29_03.htm"><IMG SRC="gifs/txtpreva.gif" ALT="Previous" border=0></A></td>
<td width=171 align=center valign=top><a href="index.htm"><img src='gifs/txthome.gif' border=0 alt='Home'></a></td>
<td width=172 align=right valign=top><A HREF="ch29_05.htm"><IMG SRC="gifs/txtnexta.gif" ALT="Next" border=0></A></td>
</tr>
<tr>
<td width=172 align=left valign=top>java.text.ChoiceFormat (JDK 1.1)</td>
<td width=171 align=center valign=top><a href="index/idx_0.htm"><img src='gifs/index.gif' alt='Book Index' border=0></a></td>
<td width=172 align=right valign=top>java.text.CollationKey (JDK 1.1)</td>
</tr>
</table>
<hr align=left width=515>

<IMG SRC="gifs/smnavbar.gif" USEMAP="#map" BORDER=0> 
<MAP NAME="map"> 
<AREA SHAPE=RECT COORDS="0,0,108,15" HREF="../javanut/index.htm"
alt="Java in a Nutshell"> 
<AREA SHAPE=RECT COORDS="109,0,200,15" HREF="../langref/index.htm" 
alt="Java Language Reference"> 
<AREA SHAPE=RECT COORDS="203,0,290,15" HREF="../awt/index.htm" 
alt="Java AWT"> 
<AREA SHAPE=RECT COORDS="291,0,419,15" HREF="../fclass/index.htm" 
alt="Java Fundamental Classes"> 
<AREA SHAPE=RECT COORDS="421,0,514,15" HREF="../exp/index.htm" 
alt="Exploring Java"> 
</MAP>
</DIV>

</BODY>
</HTML>
